package de.tuhh.simsearch.model.persistence.contentmgmt.mltools.interfaces;

/**
 * IndexingConstants contains constans used in the indexing class. These contents are strings, which represent field
 * names within the index. These constants should be used to state which fields within the index should be searched.
 * 
 * @author SimSearch 1
 * @see IndexerInterface
 */
public interface IndexingConstants {

  /**
   * The field content
   */
  public static final String CONTENT_FIELD = "content";

  /**
   * The field metadata
   */
  public static final String META_FIELD = "metadata";

  /**
   * The field file id
   */
  public static final String FILEID_FIELD = "fileid";

  /**
   * The field file name
   */
  public static final String FILENAME_FIELD = "filename";

  /**
   * The field description
   */
  public static final String DESCRIPTION_FIELD = "description";

  /**
   * The field category
   */
  public static final String CATEGORY_FIELD = "category";

  /**
   * Contains all possible search fields
   */
  public static final String[] FIELDS = { CONTENT_FIELD, META_FIELD, FILEID_FIELD, FILENAME_FIELD, DESCRIPTION_FIELD,
      CATEGORY_FIELD };
}
